Skip to content

feat: add back gc protect callback #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: add back gc protect callback #94

wants to merge 3 commits into from

Conversation

Frando
Copy link
Member

@Frando Frando commented Jul 2, 2025

Description

This adds back a way to externally protect blobs from garbage collection. It works like it did in blobs1: Users can provide an (async) callback to which a &mut HashSet<Hash> is passed. The callback is invoked before each gc run, and all hashes added to the set will be protected from gc during this run.

Used in n0-computer/iroh-docs#47

Breaking Changes

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

Copy link

github-actions bot commented Jul 2, 2025

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/94/docs/iroh_blobs/

Last updated: 2025-07-14T11:48:38Z

@n0bot n0bot bot added this to iroh Jul 2, 2025
@github-project-automation github-project-automation bot moved this to 🏗 In progress in iroh Jul 2, 2025
@Frando Frando force-pushed the Frando/gc-protect branch 2 times, most recently from 45a02c9 to 87cb4f6 Compare July 3, 2025 08:58
@Frando Frando changed the base branch from main to Frando/fix-deletion July 3, 2025 08:58
@Frando Frando force-pushed the Frando/gc-protect branch 2 times, most recently from fc473f5 to efa928e Compare July 3, 2025 10:59
@rklaehn
Copy link
Collaborator

rklaehn commented Jul 3, 2025

I don't really like add_protected, but I also don't have a better solution right now. Maybe we add it and then strongly discourage using it or mark it as unstable somehow?

Base automatically changed from Frando/fix-deletion to main July 8, 2025 07:18
@rklaehn
Copy link
Collaborator

rklaehn commented Jul 9, 2025

After thinking about this a bit, the best thing to do in the long term would be for docs to store small blobs inline and just bypass blobs entirely, then just use blobs for large blobs. The downside is of course that the small blobs stored in docs won't be available via the blobs API, but I think that is quite reasonable.

For large blobs, docs would then use the normal mechanisms (tags and temp tags) to keep the blobs alive, and the overhead would be acceptable because this would be only for a small subset of blobs.

@Frando
Copy link
Member Author

Frando commented Jul 14, 2025

Can you explain a bit why you don't like the idea of externally protecting blobs from gc long-term? To me it still looks appealing - it solves the iroh-docs usecase in a rather straightforward way, and I can see other crates building on blobs having use for this as well. If you have external datastructures that maintain their own garbage collection (like docs) it seems elegant to not have to maintain tags as well.

@Frando Frando force-pushed the Frando/gc-protect branch from efa928e to b1c9270 Compare July 14, 2025 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

2 participants